revXMLRPC_GetSocket

Type

function

Summary

This function returns the socket of an XML-RPC document.

Syntax

revXMLRPC_GetSocket(<XMLRPCdocumentID>)

Description

Use the revXMLRPC_GetSocket function to retrieve the network socket used in the execution of an XML-RPC request.

If the revXMLRPC_GetSocket function encounters an error, it returns an error message starting with "xmlrpcerr" ..

Parameters

Name	Type	Description
XMLRPCdocumentID	integer	The number returned by the revXMLRPC_CreateRequest when you created the XML-RPC request, or the successful revXMLRPC_Execute function when you executed an XML-RPC request.

Examples

put revXMLRPC_GetSocket(theRequest) into theSocket

Value

Name	Type	Description
return	string	The revXMLRPC_GetSocket function returns the socket connection that is established with the host. By default, XML-RPC uses the post command to execute an XML-RPC request, but this has the overhead of opening and closing a new socket every time. You can avoid this by re-using an already opened socket.

Related

function: revXMLRPC_CreateRequest, revXMLRPC_Execute

glossary: return, host, XML-RPC, Standalone Application Settings, socket, standalone application, function, LiveCode custom library

library: XML-RPC library

command: revXMLRPC_SetSocket, post command

control structure: function

Compatibility and Support

Introduced

LiveCode 2.5

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile